docs: repoint 5 dangling section references to their current sections - #179
Merged
Conversation
The 2026-08-22 docs flattening (6d87213) cut docs/architecture.md from 18 headings to 9 and docs/user-stories.md from 14 to 5, dropping the entire 4.x subsection layer. Five section references in tracked files have pointed at headings that no longer exist ever since: src/router.rs:1,17 architecture 4.2.1 -> 3 (module table, router.rs row) src/billing.rs:1 architecture 4.3/4.4 -> 3 (module table, billing.rs row) src/gateway.rs:1 architecture 4.1 -> 6 (API list; gateway.rs has no row in the module table) ui/README.md:25 user-stories 1.1 -> 4 (UI 约定) Each target was read at HEAD and verified to actually carry the cited content before repointing. src/db.rs:3 (architecture 5) already resolves and is deliberately left untouched. Comment/doc-only: no production behaviour change, no i18n keys, no cache-bust.
This was referenced Sep 12, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Repoint the 5 section references in tracked files that point at headings which no longer exist.
The 2026-08-22 docs flattening (
6d87213, "concise current-state docs") cutdocs/architecture.mdfrom 18 headings to 9 — deleting the entire4.xsubsection layer — anddocs/user-stories.mdfrom 14 headings to 5. Five references have cited dead headings ever since, and nothing in the repo notices: a maintainer readingsrc/router.rsgets no signal that its citation is stale.src/router.rs:1architecture §4.2.1§3 模块router.rsrow of the module tablesrc/router.rs:17architecture §4.2.1§3 模块src/billing.rs:1architecture §4.3/4.4§3 模块billing.rsrow carries token→price→pointssrc/gateway.rs:1architecture §4.1§6 API 一览gateway.rshas no row in the module table; its endpoints are listed in §6ui/README.md:25user-stories §1.1§4 UI 约定src/db.rs:3(architecture §5) already resolves and is deliberately left untouched — a blanket "delete every section reference" pass would have destroyed the only live one.Each target was read at HEAD before repointing, and each now cites a section that actually contains the content. The old numbering is kept in the two places where it still carries meaning (
router.rsandui/README.md), because the surviving document no longer has subsections, so the reader has no other way to connect the two.Related Issue
No issue exists for this — the defect was found by scanning the repository itself, not reported. Leaving this empty rather than fabricating a reference.
Changes
src/router.rs,src/billing.rs,src/gateway.rs,ui/README.md)src/db.rs:3left as-is (it resolves)Tests
cargo test— 165 passed / 0 failedcargo fmt --check— cleancargo clippy --all-targets -- -D warnings— clean, 0 warningsThe resolver walks every
§occurrence in tracked files and resolves it against the current heading set of the document it names. It carries panicking positive controls (the heading extractor must finddocs/architecture.md§1/§5 anddocs/user-stories.md§4, or it aborts rather than reporting a vacuous "clean"), and it is proven non-vacuous by running it against the pre-flatten tree (6d87213^), where the same references resolve 8 of 8 — i.e. the "rot" is real and the tool can see both states. No unit test was added: this is a documentation/comment fix with no behaviour to assert, and the repo deliberately carries no doc-linting toolchain (same call as #178).Checklist
docs/)docs:— no single scope spans threesrc/modules plusui/)